home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 April / EnigmA AMIGA RUN 17 (1997)(G.R. Edizioni)(IT)[!][issue 1997-04][EAR-CD].iso / EARCD / util / cli / wrap.lha / Wrap.readme < prev   
Text File  |  1996-12-07  |  3KB  |  83 lines
  1. Short    : Reformats text files (CLI-Pure) +GUI
  2. Uploader : dck@prometheus.hol.gr (D. Keletsekis)
  3. Author   : dck@prometheus.hol.gr (D. Keletsekis)
  4. Type     : util/cli
  5. Version  : 1.0
  6. Requires : WB 2+
  7.  
  8. This is a small CLI command for rewrapping text files.
  9. It is pure and can be made resident (Resident c:wrap pure add)
  10.  
  11. Usage  :  
  12. Wrap FILE/A,NEWFILE,L=LENGTH/K/N,TAB/K/N,P=PARA/K/N,STRIPCR/S,ADDCR/S
  13.  
  14. FILE     = Must be given. It's the file which you want to rewrap and
  15.            it must be a text file!
  16.  
  17.            *WARNING* - if you re-wrap a binary or a PowerPacked
  18.            or XPK etc file, the file will become trash! 
  19.  
  20. NEWFILE  = This is the name of the output file. If it is not given,
  21.            then the input FILE will be overwriten!
  22.  
  23. LENGTH   = The new line length you want. If this is not given, the 
  24.            default is 1000 characters, which results in leaving
  25.            the line length same (unless you have lines over 1000
  26.            characters long). If the Length given is too small to 
  27.            fit a single word, then the word will be split.
  28.            Max length is 1000 characters.
  29.  
  30. TAB      = If this option is given, then any tabs found will be 
  31.            dealt with in accordance with the number of spaces 
  32.            specified, and be converted to spaces. Maximum tab size
  33.            is 80 characters.
  34.  
  35.            *Warning* If TAB size is not declared, all tabs will be
  36.            deleted. This is not as bad as you may imagine, since Re-
  37.            wrapping files with a lot of tabs looks ugly anyway..
  38.  
  39. PARA     = This option is weird but usefull. It lets you define the
  40.            number of NEWLINE characters that Wrap will read before 
  41.            puting 1 NEWLINE character. Most text documents have a 
  42.            NEWLINE character at the end of every line, and 2 NEWLINES 
  43.            to denote a paragraph. 
  44.  
  45.            So if you put PARA=2 you will get much better formated text 
  46.            because the single NEWLINE characters will be ignored.
  47.            This option also allows you to re-wrap files to a longer
  48.            line length than the original file.
  49.  
  50.            The default is PARA=1, i.e. leave them un-altered.
  51.            Maximum is 30 newline characters.
  52.  
  53. STRIPCR  = Strips those PC Carriage Return charaters.
  54.  
  55. ADDCR    = Adds Carriage returns after every NEWLINE character, so
  56.            you can tell PC users what you really think..
  57.  
  58.            By declaring both STRIPCR *and* ADDCR you could ReWrap a
  59.            PC file and keep it in PC format.
  60.  
  61. Example : 
  62. Wrap MyFile MyOutputFile LENGTH=60 TAB=5 PARA=2 STRIPCR
  63.  
  64. There is also a GUI script included, which makes this litle
  65. command very powerful & easy to use if you want to take the
  66. same actions in a lot of files.
  67.  
  68. The GUI needs a program called Gui4Cli to run it, available at :
  69.  
  70. 1.-   http://users.hol.gr/~dck/gcmain.htm
  71. 2.-   Aminet, under Dev/Gui/Gui4Cli.lha
  72.  
  73.  
  74. D. Keletsekis
  75. December 1996
  76.  
  77. This ReadMe file is also included in the Archive.
  78.  
  79. This program is FreeWare, but remains the Copyright of D.Keletsekis.
  80. No guarantees as to it's performance and actions is made or implied.
  81. Use it at your own risk. 
  82.  
  83.